Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revise documentation #2728

Merged
merged 14 commits into from
Jan 10, 2023
Merged

Revise documentation #2728

merged 14 commits into from
Jan 10, 2023

Conversation

IgnatBeresnev
Copy link
Member

@IgnatBeresnev IgnatBeresnev commented Oct 26, 2022

Link for preview.

Alternatively, download and install Stardust plugin. Open any .md file with documentation, for instance gradle.md. On the right sidebar you'll see Stardust Article Preview, open it and you'll see rendered documentation.

Changes:

  • Renamed docs module to mkdocs to avoid confusion. You can ignore changes in mkdocs module, it's all just moved files.
  • Added a new docs Stardust module for new documentation.

Fixes #2202
Fixes #1929
Fixes #653
Fixes #614
Fixes #486
Fixes #2269
Fixes #2598

docs/dokka.tree Outdated Show resolved Hide resolved
docs/topics/runners/gradle.md Outdated Show resolved Hide resolved
docs/topics/runners/gradle.md Outdated Show resolved Hide resolved
docs/topics/runners/gradle.md Outdated Show resolved Hide resolved
docs/topics/runners/maven.md Outdated Show resolved Hide resolved
docs/topics/formats/html.md Outdated Show resolved Hide resolved
docs/topics/runners/gradle.md Outdated Show resolved Hide resolved
docs/topics/runners/gradle.md Outdated Show resolved Hide resolved
docs/topics/plugins/versioning.md Outdated Show resolved Hide resolved
docs/topics/plugins/versioning.md Outdated Show resolved Hide resolved
docs/topics/plugins/versioning.md Outdated Show resolved Hide resolved
@IgnatBeresnev
Copy link
Member Author

Addressed review comments in a separate commit, and added a quickstart section in overview

@IgnatBeresnev
Copy link
Member Author

I've updated the preview to include descriptions of configuration options for Gradle, Maven and CLI runners, and made a final round of self-review.

This is the final version from me, now it's review fixes only :)

@IgnatBeresnev
Copy link
Member Author

  • Fixed review comments that we got from the technical writers
  • Updated the preview
  • Rebased onto master and resolved merge conflicts, but had to force push

Copy link
Contributor

@sarahhaggarty sarahhaggarty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic work @IgnatBeresnev!

@IgnatBeresnev IgnatBeresnev merged commit 7544a21 into master Jan 10, 2023
@IgnatBeresnev IgnatBeresnev deleted the documentation-revise branch January 10, 2023 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
6 participants